home *** CD-ROM | disk | FTP | other *** search
/ ShareWare OnLine 2 / ShareWare OnLine Volume 2 (CMS Software)(1993).iso / comm2 / use_faq.zip / STYLE.FAQ < prev    next >
Internet Message Format  |  1992-09-06  |  5KB
  1. From news.funet.fi!sunic!mcsun!uunet!wupost!darwin.sura.net!gatech!purdue!spaf Sat Sep  5 21:10:44 EET DST 1992
  2. Article: 461 of news.announce.newusers
  3. Xref: uwasa.fi news.announce.newusers:461 news.answers:2746
  4. Path: uwasa.fi!news.funet.fi!sunic!mcsun!uunet!wupost!darwin.sura.net!gatech!purdue!spaf
  5. From: spaf@cs.purdue.EDU (Gene Spafford)
  6. Newsgroups: news.announce.newusers,news.answers
  7. Subject: Hints on writing style for Usenet
  8. Message-ID: <spaf-style_715578731@cs.purdue.edu>
  9. Date: 4 Sep 92 03:52:11 GMT
  10. Expires: 3 Nov 92 15:52:11 GMT
  11. Followup-To: news.newusers.questions
  12. Organization: Dept. of Computer Sciences, Purdue Univ.
  13. Lines: 105
  14. Approved: spaf@cs.purdue.EDU
  15. Supersedes: <spaf-style_711614929@cs.purdue.edu>
  16.  
  17. Archive-name: usenet-writing-style/part1
  18. Original-author: ofut@hubcap.clemson.edu (A. Jeff Offutt VI)
  19. Last-change: 19 July 1992 by spaf@cs.purdue.edu (Gene Spafford)
  20.  
  21. I would like to take a moment to share some of my knowledge of writing
  22. style.  If you read the suggestions below, remember: it's easy to agree
  23. that they make sense but it's much harder to apply them.
  24.  
  25. References: 
  26.  Cunningham and Pearsall, "How to Write For the World of Work"
  27.  Strunk & White, "Elements of Style"
  28.  
  29. The above references are both excellent books.  Cunningham is a
  30. standard in tech writing classes and won an award for the best tech
  31. writing book from the Association for Teaching of Technical Writing.  I
  32. was lucky enough to take a class from him as an undergraduate.  Strunk
  33. is a standard in college composition classes.  Other ideas here come
  34. from my own experience on the net and hints from other people.
  35.  
  36. This is a "long article." The rest of it is simply a list of pointers.
  37.  
  38.                Writing style:
  39.  
  40.  * Write *below* the readers' reading level.  The avg. person in the US
  41.    reads at a 5th grade level (11 years of age). The avg. professional
  42.    reads at about the 12th grade level (18 years of age).
  43.  
  44.  * Keep paragraphs short and sweet.  Keep sentences shorter and sweeter. 
  45.    This means "concise," not cryptic.
  46.  
  47.  * White space is not wasted space -- it greatly improves clarity.
  48.    A blank line only adds a byte to the article length, so don't be
  49.    stingy if it will help make your meaning clearer.
  50.  
  51.  * Pick your words carefully.  Writing with precision is as important
  52.    here as it is in any other kind of discourse.  Consider carefully
  53.    whether what you have written can be misinterpreted, and whether
  54.    that is something you wish to have happen.
  55.  
  56.  
  57.  * People can only grasp about seven things at once.  This means ideas in a
  58.    paragraph, major sections, etc..
  59.  
  60.  * Avoid abbreviations and acronyms, if possible, and define the ones
  61.    you use.
  62.  
  63.  * There are several variations on any one sentence.  A passive, questioning
  64.    or negative sentence takes longer to read.
  65.  
  66.  * "Cute" misspellings are difficult to read, especially if the reader
  67.     is not fluent in the language involved.
  68.  
  69.  
  70.  
  71.                Net style:
  72.  
  73.  * Subtlety is not communicated well in written form - especially over a 
  74.    computer.
  75.  
  76.  * The above applies to humor as well. (rec.humor, of course, not included.)
  77.  
  78.  * When being especially "flame-boyant", I find it helpful to go to the
  79.    bathroom before actually sending.  Then, I often change the tone
  80.    considerably. :-) Take a break before posting something in anger or that
  81.    might hurt or anger others.
  82.  
  83.  * Subject lines should be used very carefully.  How much time have you
  84.    wasted reading articles with a misleading subject line?  The "Subject:"
  85.    header line can be edited in all the various posting programs
  86.    (as can the "Distribution:", "Newsgroups:" and "Followup-To:" header
  87.    lines).
  88.  
  89.  * References need to be made.  When you answer mail, you have the original
  90.    message fresh in your mind.  When I receive your answer, I don't.
  91.  
  92.  * It's *much* easier to read a mixture of upper and lower case letters.
  93.  
  94.  * Leaving out articles (such as "the," "a," "an," etc.) for "brevity"
  95.    mangles the meaning of your sentences and takes longer to read. It saves
  96.    you time at the expense of your reader.
  97.  
  98.  * Be careful of contextual meanings of words. For instance, I used "articles" 
  99.    just now.  In the context of netnews, it has a different meaning than I 
  100.    intended.
  101.  
  102.  * Make an effort to spell words correctly.  Obvious misspellings are
  103.    jarring and distract the reader.  Every news posting program allows
  104.    you to edit your article before posting, and most systems have some
  105.    kind of spelling checker program that you can use on your article.
  106.  
  107.  * Remember - this is an international network.
  108.  
  109.  * Remember - your current or future employers may be reading your
  110.    articles.  So might your spouse, neighbors, children, and others
  111.    who will long-remember your gaffes.
  112.  
  113. Enough said.  
  114.  
  115. These suggestions are all easily supported by arguments and research.
  116. There's a lot more to say, but....
  117. -- 
  118. Gene Spafford
  119. Software Engineering Research Center & Dept. of Computer Sciences
  120. Purdue University, W. Lafayette IN 47907-1398
  121. Internet:  spaf@cs.purdue.edu    phone:  (317) 494-7825
  122.  
  123.  
  124.